﻿/**
 *       Project: ServerLib
 *     Copyright: Copyright (C) 2008, Rob Kennedy
 *   Create Date: 2008-07-15 3:40 PM
 * Modified Date: 2008-07-15 3:40 PM    RK  Added comments
 *      Comments: Ignore SA1633.
 *      
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

namespace ServerLib.Plugin
{
    using Network;
    using Security;
    using ServerLib.Data;

    /// --------------------------------------------------------------------
    /// Project	 : ServerLib
    /// Class	 : IServicePluginContext
    /// Inherits : None.
    /// --------------------------------------------------------------------
    /// <summary>
    /// Interface class for application plugin library context
    /// </summary>
    /// <authorname>Rob Kennedy</authorname>
    /// <remarks></remarks>
    /// --------------------------------------------------------------------
    public interface IServicePluginContext
    {
        /// <summary>
        /// Gets the current user session information
        /// </summary>
        UserAccount UserAccount
        { 
            get; 
        }
        
        /// <summary>
        /// Gets the current client socket object
        /// </summary>
        EnhancedSocket ClientTcp 
        { 
            get; 
        }

        /// <summary>
        /// Gets or sets the Log file Service Name for internal logging
        /// </summary>
        string LoggingServiceName 
        { 
            get; 
            set; 
        }


        /// <summary>Contains the database connection object for this plugin</summary>
        IDatabase DB
        {
            get;
            set;
        }

        /// <summary>
        /// Gets or sets a value indicating whether the plugin logs in verbose mode
        /// </summary>
        bool Verbose 
        { 
            get; 
            set; 
        }

        /// <summary>
        /// Gets an additional optional object parameter for the library
        /// </summary>
        object OptionalParameter 
        { 
            get; 
        }
    }
}
